Add "Create API Token" and "Delete API Token" calls #148
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
feat(axiom-py): Add support for creating and deleting API tokens
Update `axiom-py` fork to v0.5.0
Update to v0.8.0
bahlo
reviewed
Oct 23, 2024
Comment on lines
+15
to
+26
| # Ability to ingest data. Optional. | ||
| ingest: Optional[list[Literal["create"]]] = field(default=None) | ||
| # Ability to query data. Optional. | ||
| query: Optional[list[Literal["read"]]] = field(default=None) | ||
| # Ability to use starred queries. Optional. | ||
| starredQueries: Optional[ | ||
| list[Literal["create", "read", "update", "delete"]] | ||
| ] = field(default=None) | ||
| # Ability to use virtual fields. Optional. | ||
| virtualFields: Optional[ | ||
| list[Literal["create", "read", "update", "delete"]] | ||
| ] = field(default=None) |
There was a problem hiding this comment.
This is missing data, trim and vacuum:
Suggested change
| # Ability to ingest data. Optional. | |
| ingest: Optional[list[Literal["create"]]] = field(default=None) | |
| # Ability to query data. Optional. | |
| query: Optional[list[Literal["read"]]] = field(default=None) | |
| # Ability to use starred queries. Optional. | |
| starredQueries: Optional[ | |
| list[Literal["create", "read", "update", "delete"]] | |
| ] = field(default=None) | |
| # Ability to use virtual fields. Optional. | |
| virtualFields: Optional[ | |
| list[Literal["create", "read", "update", "delete"]] | |
| ] = field(default=None) | |
| # Data management capability. Optional. | |
| data: Optional[list[Literal["delete"]]] = field(default=None) | |
| # Ability to ingest data. Optional. | |
| ingest: Optional[list[Literal["create"]]] = field(default=None) | |
| # Ability to query data. Optional. | |
| query: Optional[list[Literal["read"]]] = field(default=None) | |
| # Ability to use starred queries. Optional. | |
| starredQueries: Optional[ | |
| list[Literal["create", "read", "update", "delete"]] | |
| ] = field(default=None) | |
| # Trim capability. Optional | |
| trim: Optional[list[Literal["update"]]] = field(default=None) | |
| # Vacuum capability. Optional | |
| vacuum: Optional[list[Literal["update"]]] = field(default=None) | |
| # Ability to use virtual fields. Optional. | |
| virtualFields: Optional[ | |
| list[Literal["create", "read", "update", "delete"]] | |
| ] = field(default=None) |
| apiTokens: Optional[ | ||
| list[Literal["create", "read", "update", "delete"]] | ||
| ] = field(default=None) | ||
| # Ability to access billing. Optional. |
There was a problem hiding this comment.
Missing audit log:
Suggested change
| # Ability to access billing. Optional. | |
| # Audit log capability. Optional. | |
| auditLog: Optional[ | |
| list[Literal["read"]] | |
| ] = field(default=None) | |
| # Ability to access billing. Optional. |
Comment on lines
+316
to
+329
| def create_api_token(self, opts: TokenAttributes) -> Token: | ||
| """Creates a new API token with permissions specified in a TokenAttributes object.""" | ||
| res = self.session.post( | ||
| "/v2/tokens", | ||
| data=ujson.dumps(asdict(opts), default=handle_json_serialization), | ||
| ) | ||
|
|
||
| # Return the new token and ID. | ||
| response = res.json() | ||
| return Token(id=response["id"], token=response["token"]) | ||
|
|
||
| def delete_api_token(self, token_id: str) -> None: | ||
| """Delete an API token using its ID string.""" | ||
| self.session.delete(f"/v2/tokens/{token_id}") |
There was a problem hiding this comment.
Please move this into a TokenClient in tokens.py, similar to
axiom-py/src/axiom_py/datasets.py
Lines 49 to 55 in c9ec206
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello,
A few weeks ago, we discussed submitting a pull request with the "create / delete API token" logic that we have been using to programmatically set up API keys using the
axiom-pypackage. Sorry for the delay in submitting this - I was OOTO recently and just got around to it.The logic should be fairly simple, and I did my best to structure the API parameters according to your documentation and existing conventions. But please let me know if you have any questions or concerns.
Thank you!